/*
 * Copyright (c) 2011 Seoul National University
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Jung Ho Ahn  ( gajh@snu.ac.kr )
 *
 */

#ifndef __NODE_H__
#define __NODE_H__

#include "Kmer.h"

enum node_type
{
  ndt_kmer,
  ndt_contig,
  ndt_invalid
};

ostream & operator<<(ostream & output, node_type ndt);

class Node
{
  public:
    Node(node_type type_, uint64_t id_) : has_branch(false), valid(true), type(type_), id(id_) { }
    ~Node() { }

    Node * getPrev(nucleotide_type nucleotide = nt_A) { exit(1); }
    Node * getNext(nucleotide_type nucleotide = nt_A) { exit(1); }

    void setPrev(Node * node, nucleotide_type  nucleotide = nt_A) { exit(1); }
    void setNext(Node * node, nucleotide_type  nucleotide = nt_A) { exit(1); }

    inline bool hasBranch() const { return has_branch; }
    void fastaDisplay(ostream & out) { }
    void * operator new(size_t num_bytes, size_t memAddr) { return (void *)memAddr; }
    void operator delete(void * p) { exit(1); }

  protected:
    bool has_branch : 1;
    bool      valid : 1;
    node_type  type : 3; 
    uint64_t    id : 59;  // this is optional -- for debugging

    friend class KmerCoverageTable;
    friend class Graph;
    friend class ContigNode;
    friend ostream & operator<<(ostream & out, const class ContigNode & k);
    friend ostream & operator<<(ostream & out, const class KmerNode & k);
};

#endif  // __NODE_H__ 
